// Copyright (c) Appeon. All rights reserved.
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. 
// You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

namespace SnapObjects.Data
{
    /// <summary>
    ///     Represents an object, which uses the AND or OR logical operator and adds a search condition in the ON clause of a SQL statement. 
    ///     The return values of all methods are always the current ISqlJoinOnAndOr object.
    /// </summary>
    public interface ISqlJoinOnAndOr : ISqlJoinOnAndOr<ISqlJoinOnAndOr>, ISqlWhereBuilder
    {

    }

    /// <summary>
    ///     Represents an object, which uses the AND or OR logical operator and adds a search condition in the ON clause of a SQL statement. 
    ///     The return values of all methods are always the current TBuilder object.
    /// </summary>
    /// <typeparam name="TBuilder"></typeparam>
    public interface ISqlJoinOnAndOr<TBuilder>
    {
        /// <summary>
        ///     Gets whether any search condition has been added to the ON clause using the On or OnRaw method and so on.
        /// </summary>
        bool HasOn { get; }

        /// <summary>
        ///     Adds the AND logical operator and a search condition to the ON clause; and specifies a SQL expression on 
        ///     the left the operator and a specific value on the right of the operator. The operator is '='.
        /// </summary>
        /// <param name="left">An expression on the left of the operator.</param>
        /// <param name="value">A specific value on the right of the operator.</param>
        /// <returns>
        ///     Returns the TBuilder object which can be used to add more search conditions to the current ON clause.
        /// </returns>
        TBuilder AndOnValue(string left, object value);

        /// <summary>
        ///     Adds the AND logical operator and a search condition to the ON clause; and specifies a SQL expression on 
        ///     the left the operator and a specific value on the right of the operator.
        /// </summary>
        /// <param name="left">An expression on the left of the operator.</param>
        /// <param name="sqlOperator">
        ///     An enumeration value of SqlBinaryOperator, which is the operator to test the expression on the left and
        ///     the value on the right.
        /// </param>
        /// <param name="value">A specific value on the right of the operator.</param>
        /// <returns>
        ///     Returns the TBuilder object which can be used to add more search conditions to the current ON clause.
        /// </returns>
        TBuilder AndOnValue(string left, SqlBinaryOperator sqlOperator, object value);

        /// <summary>
        ///     Adds the AND logical operator and a search condition to the ON clause; and specifies a SQL expression on the 
        ///     left of the operator and a SQL parameter on the right of the operator. The operator is '='.
        /// </summary>
        /// <param name="left">A SQL expression on the left of the operator.</param>
        /// <param name="parameter">
        ///     An ISqlParameter object which represents a SQL parameter on the right of the operator.
        ///     It can be created by calling the SqlBuilder.Parameter method.
        /// </param>
        /// <returns>
        ///     Returns the TBuilder object which can be used to add more search conditions to the current ON clause.
        /// </returns>
        TBuilder AndOn(string left, ISqlParameter parameter);

        /// <summary>
        ///     Adds the AND logical operator and a search condition to the ON clause; and specifies a SQL expression on
        ///     the left of the operator and a SQL parameter on the right of the operator.
        /// </summary>
        /// <param name="left">A SQL expression on the left of the operator.</param>
        /// <param name="sqlOperator">
        ///     An enumeration value of SqlBinaryOperator, which is the operator to test the two expressions on the left and right.
        /// </param>
        /// <param name="parameter">
        ///     An ISqlParameter object which represents a SQL parameter on the right of the operator.
        ///     It can be created by calling the SqlBuilder.Parameter method.
        /// </param>
        /// <returns>
        ///     Returns the TBuilder object which can be used to add more search conditions to the current ON clause.
        /// </returns>
        TBuilder AndOn(string left, SqlBinaryOperator sqlOperator, ISqlParameter parameter);

        /// <summary>
        ///     Adds the AND logical operator and a search condition to the ON clause; and specifies SQL expressions 
        ///     on both the left and right of the operator. The operator is '='.
        /// </summary>
        /// <param name="left">A SQL expression on the left of the operator.</param>
        /// <param name="right">A SQL expression on the right of the operator.</param>
        /// <returns>
        ///     Returns the TBuilder object which can be used to add more search conditions to the current ON clause.
        /// </returns>
        TBuilder AndOn(string left, string right);

        /// <summary>
        ///     Adds the AND logical operator and a search condition to the ON clause; and specifies SQL expressions
        ///     on both the left and right of the operator.
        /// </summary>
        /// <param name="left">A SQL expression on the left of the operator.</param>
        /// <param name="sqlOperator">
        ///     An enumeration value of SqlBinaryOperator, which is the operator to test the two expressions on the left and right.
        /// </param>
        /// <param name="right">A SQL expression on the right of the operator.</param>
        /// <returns>
        ///     Returns the TBuilder object which can be used to add more search conditions to the current ON clause.
        /// </returns>
        TBuilder AndOn(string left, SqlBinaryOperator sqlOperator, string right);

        /// <summary>
        ///     Adds the AND logical operator and a search condition to the ON clause; and specifies a SQL expression on 
        ///     the left of the operator and a SQL subquery on the right. The operator is '='.
        /// </summary>
        /// <param name="left">A SQL expression on the left of the operator.</param>
        /// <param name="sqlBuilder">
        ///     An ISqlBuilder object which represents a SQL subquery on the right of the operator.
        /// </param>
        /// <returns>
        ///     Returns the TBuilder object which can be used to add more search conditions to the current ON clause.
        /// </returns>
        TBuilder AndOn(string left, ISqlBuilder sqlBuilder);

        /// <summary>
        ///     Adds the AND logical operator and a search condition to the ON clause; and specifies a SQL expression on 
        ///     the left of the operator and a SQL subquery on the right.
        /// </summary>
        /// <param name="left">A SQL expression on the left of the operator.</param>
        /// <param name="sqlOperator">
        ///     An enumeration value of SqlBinaryOperator, which is the operator to test the two expressions on the left and right.
        /// </param>
        /// <param name="sqlBuilder">
        ///     An ISqlBuilder object which represents a SQL subquery on the right of the operator.
        /// </param>
        /// <returns>
        ///     Returns the TBuilder object which can be used to add more search conditions to the current ON clause.
        /// </returns>
        TBuilder AndOn(string left, SqlBinaryOperator sqlOperator, ISqlBuilder sqlBuilder);

        /// <summary>
        ///     Adds the AND logical operator and a search condition (specified by an ISqlJoinCondition object) to the ON clause.
        /// </summary>
        /// <param name="condition">
        ///     An ISqlJoinCondition object which represents a search condition in the ON clause.
        ///     This object can be created by using the SqlBuilder.On method and so on.
        /// </param>
        /// <returns>
        ///     Returns the TBuilder object which can be used to add more search conditions to the current ON clause.
        /// </returns>
        TBuilder AndOn(ISqlJoinCondition condition);

        /// <summary>
        ///     Adds the AND logical operator and a raw SQL to the ON clause.
        /// </summary>
        /// <param name="clause">A string of raw SQL to be added to the ON clause.</param>
        /// <param name="parameters">
        ///     (Optional) An array of ISqlParameter objects which define the SQL parameters used in the raw SQL.
        /// </param>
        /// <returns>
        ///     Returns the TBuilder object which can be used to add more search conditions to the current ON clause.
        /// </returns>
        TBuilder AndOnRaw(string clause, params ISqlParameter[] parameters);

        /// <summary>
        ///     Adds the OR logical operator and a search condition to the ON clause; and specifies a SQL expression on 
        ///     the left of the operator and a specific value on the right of the operator. The operator is '='.
        /// </summary>
        /// <param name="left">An expression on the left of the operator.</param>
        /// <param name="value">
        ///     A specific value on the right of the operator.
        /// </param>
        /// <returns>
        ///     Returns the TBuilder object which can be used to add more search conditions to the current ON clause.
        /// </returns>
        TBuilder OrOnValue(string left, object value);

        /// <summary>
        ///     Adds the OR logical operator and a search condition to the ON clause; and specifies a SQL expression on 
        ///     the left of the operator and a specific value on the right of the operator.
        /// </summary>
        /// <param name="left">An expression on the left of the operator.</param>
        /// <param name="sqlOperator">
        ///     An enumeration value of SqlBinaryOperator, which is the operator to test the expression on the left
        ///     and the value on the right.
        /// </param>
        /// <param name="value">A specific value on the right of the operator.</param>
        /// <returns>
        ///     Returns the TBuilder object which can be used to add more search conditions to the current ON clause.
        /// </returns>
        TBuilder OrOnValue(string left, SqlBinaryOperator sqlOperator, object value);

        /// <summary>
        ///     Adds the OR logical operator and a search condition to the ON clause; and specifies a SQL expression on
        ///     the left of the operator and a SQL parameter on the right of the operator. The operator is '='.
        /// </summary>
        /// <param name="left">A SQL expression on the left of the operator.</param>
        /// <param name="parameter">
        ///     An ISqlParameter object which represents a SQL parameter on the right of the operator.
        ///     It can be created by calling the SqlBuilder.Parameter method.
        /// </param>
        /// <returns>
        ///     Returns the TBuilder object which can be used to add more search conditions to the current ON clause.
        /// </returns>
        TBuilder OrOn(string left, ISqlParameter parameter);

        /// <summary>
        ///     Adds the OR logical operator and a search condition to the ON clause; and specifies a SQL expression on
        ///     the left of the operator and a SQL parameter on the right of the operator.
        /// </summary>
        /// <param name="left">A SQL expression on the left of the operator.</param>
        /// <param name="sqlOperator">
        ///     An enumeration value of SqlBinaryOperator, which is the operator to test the two expressions on the left and right.
        /// </param>
        /// <param name="parameter">
        ///     An ISqlParameter object which represents a SQL parameter on the right of the operator.
        ///     It can be created by calling the SqlBuilder.Parameter method.
        /// </param>
        /// <returns>
        ///     Returns the TBuilder object which can be used to add more search conditions to the current ON clause.
        /// </returns>
        TBuilder OrOn(string left, SqlBinaryOperator sqlOperator, ISqlParameter parameter);

        /// <summary>
        ///     Adds the OR logical operator and a search condition to the ON clause; and specifies SQL expressions on
        ///     both the left and right of the operator. The operator is '='.
        /// </summary>
        /// <param name="left">A SQL expression on the left of the operator.</param>
        /// <param name="right">A SQL expression on the right of the operator.</param>
        /// <returns>
        ///     Returns the TBuilder object which can be used to add more search conditions to the current ON clause.
        /// </returns>
        TBuilder OrOn(string left, string right);

        /// <summary>
        ///     Adds the OR logical operator and a search condition to the ON clause; and specifies SQL expressions on
        ///     both the left and right of the operator.
        /// </summary>
        /// <param name="left">A SQL expression on the left of the operator.</param>
        /// <param name="sqlOperator">
        ///     An enumeration value of SqlBinaryOperator, which is the operator to test the two expressions on the left and right.
        /// </param>
        /// <param name="right">A SQL expression on the right of the operator.</param>
        /// <returns>
        ///     Returns the TBuilder object which can be used to add more search conditions to the current ON clause.
        /// </returns>
        TBuilder OrOn(string left, SqlBinaryOperator sqlOperator, string right);

        /// <summary>
        ///     Adds the OR logical operator and a search condition to the ON clause; and specifies a SQL expression on the 
        ///     left of the operator and a SQL subquery on the right. The operator is '='.
        /// </summary>
        /// <param name="left">A SQL expression on the left of the operator.</param>
        /// <param name="sqlBuilder">
        ///     An ISqlBuilder object which represents a SQL subquery on the right of the operator.
        /// </param>
        /// <returns>
        ///     Returns the TBuilder object which can be used to add more search conditions to the current ON clause.
        /// </returns>
        TBuilder OrOn(string left, ISqlBuilder sqlBuilder);

        /// <summary>
        ///     Adds the OR logical operator and a search condition to the ON clause; and specifies a SQL expression on the
        ///     left of the operator and a SQL subquery on the right.
        /// </summary>
        /// <param name="left">A SQL expression on the left of the operator.</param>
        /// <param name="sqlOperator">
        ///     An enumeration value of SqlBinaryOperator, which is the operator to test the two expressions on the left and right.
        /// </param>
        /// <param name="sqlBuilder">
        ///     An ISqlBuilder object which represents a SQL subquery on the right of the operator.
        /// </param>
        /// <returns>
        ///     Returns the TBuilder object which can be used to add more search conditions to the current ON clause.
        /// </returns>
        TBuilder OrOn(string left, SqlBinaryOperator sqlOperator, ISqlBuilder sqlBuilder);

        /// <summary>
        ///     Adds the OR logical operator and a search condition (specified by an ISqlJoinCondition object) to the ON clause.
        /// </summary>
        /// <param name="condition">
        ///     An ISqlJoinCondition object which represents a search condition in the ON Clause.
        ///     This object can be created by using the SqlBuilder.On method and so on.
        /// </param>
        /// <returns>
        ///     Returns the TBuilder object which can be used to add more search conditions to the current ON clause.
        /// </returns>
        TBuilder OrOn(ISqlJoinCondition condition);

        /// <summary>
        ///     Adds the OR logical operator and a raw SQL to the ON clause.
        /// </summary>
        /// <param name="clause">A string of raw SQL to be added to the ON clause.</param>
        /// <param name="parameters">
        ///     (Optional) An array of ISqlParameter objects which define the SQL parameters used in the raw SQL.
        /// </param>
        /// <returns>
        ///     Returns the TBuilder object which can be used to add more search conditions to the current ON clause.
        /// </returns>
        TBuilder OrOnRaw(string clause, params ISqlParameter[] parameters);
    }
}
